Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(types/custom-element): defineCustomElement with required props #11578

Merged
merged 1 commit into from
Aug 15, 2024
Merged

fix(types/custom-element): defineCustomElement with required props #11578

merged 1 commit into from
Aug 15, 2024

Conversation

andylizi
Copy link
Contributor

Fixes type error when using defineCustomElement with required: true props.

const Comp1Vue = defineComponent({
  props: {
    a: { type: Number, required: true },
  },
})
const Comp = defineCustomElement(Comp1Vue)
//                               ^^^^^^^^ No overload matches this call. ts(2769)
No overload matches this call.
  The last overload gave the following error.
    Argument of type 'DefineComponent<ExtractPropTypes<{ a: { type: NumberConstructor; required: true; }; }>, ...>' is not assignable to parameter of type 'DefineComponent<any, any, any, any>'.
      Type 'DefineComponent<ExtractPropTypes<{ a: { type: NumberConstructor; required: true; }; }>, ...>' is not assignable to type 'ComponentOptionsBase<Readonly<any>, ...>'.
        Types of property 'setup' are incompatible.
          Type '(this: void, props: LooseRequired<Readonly<{ a: number; } & {} & {}> & {}>, ...) => void | ...' is not assignable to type '(this: void, props: LooseRequired<Readonly<any> & {}>, ...) => any'.
            Types of parameters 'props' and 'props' are incompatible.
              Property 'a' is missing in type 'LooseRequired<Readonly<any> & {}>' but required in type 'LooseRequired<Readonly<{ a: number; } & {} & {}> & {}>'.

In addition, this PR also removes an unnecessary ExtractPropTypes. Before this change:

const Comp: VueElementConstructor<ExtractPropTypes<ExtractPropTypes<{
    a: {
        type: NumberConstructor;
        required: true;
    };
}>>>
// `Comp` is `VueElementConstructor<{ a?: number | undefined }>`

After this change:

const Comp: VueElementConstructor<ExtractPropTypes<{
    a: {
        type: NumberConstructor;
        required: true;
    };
}>>
// `Comp` is `VueElementConstructor<{ a: number }>`

@yyx990803 yyx990803 merged commit 77d5e88 into vuejs:minor Aug 15, 2024
11 checks passed
@andylizi andylizi deleted the fix-ce-required-props branch August 15, 2024 03:21
edison1105 added a commit to edison1105/vuejs-core that referenced this pull request Aug 16, 2024
@edison1105
Revert "fix(types/custom-element): defineCustomElement with require…
80764e8 
…d props (vuejs#11578)"

This reverts commit 77d5e88.
yyx990803 pushed a commit that referenced this pull request Aug 16, 2024
@andylizi @yyx990803
fix(types/custom-element): defineCustomElement with required props (#…
5e0f6d5 
…11578)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@andylizi @yyx990803